home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1997 April / macformat-049.iso / mac / Shareware Plus / Developers / dropg++ / usr / include / sys / protosw.h < prev    next >
Encoding:
C/C++ Source or Header  |  1997-02-20  |  8.8 KB  |  211 lines  |  [TEXT/R*ch]
  1. /*-
  2.  * Copyright (c) 1982, 1986, 1993
  3.  *    The Regents of the University of California.  All rights reserved.
  4.  *
  5.  * Redistribution and use in source and binary forms, with or without
  6.  * modification, are permitted provided that the following conditions
  7.  * are met:
  8.  * 1. Redistributions of source code must retain the above copyright
  9.  *    notice, this list of conditions and the following disclaimer.
  10.  * 2. Redistributions in binary form must reproduce the above copyright
  11.  *    notice, this list of conditions and the following disclaimer in the
  12.  *    documentation and/or other materials provided with the distribution.
  13.  * 3. All advertising materials mentioning features or use of this software
  14.  *    must display the following acknowledgement:
  15.  *    This product includes software developed by the University of
  16.  *    California, Berkeley and its contributors.
  17.  * 4. Neither the name of the University nor the names of its contributors
  18.  *    may be used to endorse or promote products derived from this software
  19.  *    without specific prior written permission.
  20.  *
  21.  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22.  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23.  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24.  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25.  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26.  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27.  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28.  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29.  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30.  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31.  * SUCH DAMAGE.
  32.  *
  33.  *    @(#)protosw.h    8.1 (Berkeley) 6/2/93
  34.  */
  35.  
  36. /*
  37.  * Protocol switch table.
  38.  *
  39.  * Each protocol has a handle initializing one of these structures,
  40.  * which is used for protocol-protocol and system-protocol communication.
  41.  *
  42.  * A protocol is called through the pr_init entry before any other.
  43.  * Thereafter it is called every 200ms through the pr_fasttimo entry and
  44.  * every 500ms through the pr_slowtimo for timer based actions.
  45.  * The system will call the pr_drain entry if it is low on space and
  46.  * this should throw away any non-critical data.
  47.  *
  48.  * Protocols pass data between themselves as chains of mbufs using
  49.  * the pr_input and pr_output hooks.  Pr_input passes data up (towards
  50.  * UNIX) and pr_output passes it down (towards the imps); control
  51.  * information passes up and down on pr_ctlinput and pr_ctloutput.
  52.  * The protocol is responsible for the space occupied by any the
  53.  * arguments to these entries and must dispose it.
  54.  *
  55.  * The userreq routine interfaces protocols to the system and is
  56.  * described below.
  57.  */
  58. struct protosw {
  59.     short    pr_type;        /* socket type used for */
  60.     struct    domain *pr_domain;    /* domain protocol a member of */
  61.     short    pr_protocol;        /* protocol number */
  62.     short    pr_flags;        /* see below */
  63. /* protocol-protocol hooks */
  64.     void    (*pr_input)();        /* input to protocol (from below) */
  65.     int    (*pr_output)();        /* output to protocol (from above) */
  66.     void    (*pr_ctlinput)();    /* control input (from below) */
  67.     int    (*pr_ctloutput)();    /* control output (from above) */
  68. /* user-protocol hook */
  69.     int    (*pr_usrreq)();        /* user request: see list below */
  70. /* utility hooks */
  71.     void    (*pr_init)();        /* initialization hook */
  72.     void    (*pr_fasttimo)();    /* fast timeout (200ms) */
  73.     void    (*pr_slowtimo)();    /* slow timeout (500ms) */
  74.     void    (*pr_drain)();        /* flush any excess space possible */
  75.     int    (*pr_sysctl)();        /* sysctl for protocol */
  76. };
  77.  
  78. #define    PR_SLOWHZ    2        /* 2 slow timeouts per second */
  79. #define    PR_FASTHZ    5        /* 5 fast timeouts per second */
  80.  
  81. /*
  82.  * Values for pr_flags.
  83.  * PR_ADDR requires PR_ATOMIC;
  84.  * PR_ADDR and PR_CONNREQUIRED are mutually exclusive.
  85.  */
  86. #define    PR_ATOMIC    0x01        /* exchange atomic messages only */
  87. #define    PR_ADDR        0x02        /* addresses given with messages */
  88. #define    PR_CONNREQUIRED    0x04        /* connection required by protocol */
  89. #define    PR_WANTRCVD    0x08        /* want PRU_RCVD calls */
  90. #define    PR_RIGHTS    0x10        /* passes capabilities */
  91.  
  92. /*
  93.  * The arguments to usrreq are:
  94.  *    (*protosw[].pr_usrreq)(up, req, m, nam, opt);
  95.  * where up is a (struct socket *), req is one of these requests,
  96.  * m is a optional mbuf chain containing a message,
  97.  * nam is an optional mbuf chain containing an address,
  98.  * and opt is a pointer to a socketopt structure or nil.
  99.  * The protocol is responsible for disposal of the mbuf chain m,
  100.  * the caller is responsible for any space held by nam and opt.
  101.  * A non-zero return from usrreq gives an
  102.  * UNIX error number which should be passed to higher level software.
  103.  */
  104. #define    PRU_ATTACH        0    /* attach protocol to up */
  105. #define    PRU_DETACH        1    /* detach protocol from up */
  106. #define    PRU_BIND        2    /* bind socket to address */
  107. #define    PRU_LISTEN        3    /* listen for connection */
  108. #define    PRU_CONNECT        4    /* establish connection to peer */
  109. #define    PRU_ACCEPT        5    /* accept connection from peer */
  110. #define    PRU_DISCONNECT        6    /* disconnect from peer */
  111. #define    PRU_SHUTDOWN        7    /* won't send any more data */
  112. #define    PRU_RCVD        8    /* have taken data; more room now */
  113. #define    PRU_SEND        9    /* send this data */
  114. #define    PRU_ABORT        10    /* abort (fast DISCONNECT, DETATCH) */
  115. #define    PRU_CONTROL        11    /* control operations on protocol */
  116. #define    PRU_SENSE        12    /* return status into m */
  117. #define    PRU_RCVOOB        13    /* retrieve out of band data */
  118. #define    PRU_SENDOOB        14    /* send out of band data */
  119. #define    PRU_SOCKADDR        15    /* fetch socket's address */
  120. #define    PRU_PEERADDR        16    /* fetch peer's address */
  121. #define    PRU_CONNECT2        17    /* connect two sockets */
  122. /* begin for protocols internal use */
  123. #define    PRU_FASTTIMO        18    /* 200ms timeout */
  124. #define    PRU_SLOWTIMO        19    /* 500ms timeout */
  125. #define    PRU_PROTORCV        20    /* receive from below */
  126. #define    PRU_PROTOSEND        21    /* send to below */
  127.  
  128. #define    PRU_NREQ        21
  129.  
  130. #ifdef PRUREQUESTS
  131. char *prurequests[] = {
  132.     "ATTACH",    "DETACH",    "BIND",        "LISTEN",
  133.     "CONNECT",    "ACCEPT",    "DISCONNECT",    "SHUTDOWN",
  134.     "RCVD",        "SEND",        "ABORT",    "CONTROL",
  135.     "SENSE",    "RCVOOB",    "SENDOOB",    "SOCKADDR",
  136.     "PEERADDR",    "CONNECT2",    "FASTTIMO",    "SLOWTIMO",
  137.     "PROTORCV",    "PROTOSEND",
  138. };
  139. #endif
  140.  
  141. /*
  142.  * The arguments to the ctlinput routine are
  143.  *    (*protosw[].pr_ctlinput)(cmd, sa, arg);
  144.  * where cmd is one of the commands below, sa is a pointer to a sockaddr,
  145.  * and arg is an optional caddr_t argument used within a protocol family.
  146.  */
  147. #define    PRC_IFDOWN        0    /* interface transition */
  148. #define    PRC_ROUTEDEAD        1    /* select new route if possible ??? */
  149. #define    PRC_QUENCH2        3    /* DEC congestion bit says slow down */
  150. #define    PRC_QUENCH        4    /* some one said to slow down */
  151. #define    PRC_MSGSIZE        5    /* message size forced drop */
  152. #define    PRC_HOSTDEAD        6    /* host appears to be down */
  153. #define    PRC_HOSTUNREACH        7    /* deprecated (use PRC_UNREACH_HOST) */
  154. #define    PRC_UNREACH_NET        8    /* no route to network */
  155. #define    PRC_UNREACH_HOST    9    /* no route to host */
  156. #define    PRC_UNREACH_PROTOCOL    10    /* dst says bad protocol */
  157. #define    PRC_UNREACH_PORT    11    /* bad port # */
  158. /* was    PRC_UNREACH_NEEDFRAG    12       (use PRC_MSGSIZE) */
  159. #define    PRC_UNREACH_SRCFAIL    13    /* source route failed */
  160. #define    PRC_REDIRECT_NET    14    /* net routing redirect */
  161. #define    PRC_REDIRECT_HOST    15    /* host routing redirect */
  162. #define    PRC_REDIRECT_TOSNET    16    /* redirect for type of service & net */
  163. #define    PRC_REDIRECT_TOSHOST    17    /* redirect for tos & host */
  164. #define    PRC_TIMXCEED_INTRANS    18    /* packet lifetime expired in transit */
  165. #define    PRC_TIMXCEED_REASS    19    /* lifetime expired on reass q */
  166. #define    PRC_PARAMPROB        20    /* header incorrect */
  167.  
  168. #define    PRC_NCMDS        21
  169.  
  170. #define    PRC_IS_REDIRECT(cmd)    \
  171.     ((cmd) >= PRC_REDIRECT_NET && (cmd) <= PRC_REDIRECT_TOSHOST)
  172.  
  173. #ifdef PRCREQUESTS
  174. char    *prcrequests[] = {
  175.     "IFDOWN", "ROUTEDEAD", "#2", "DEC-BIT-QUENCH2",
  176.     "QUENCH", "MSGSIZE", "HOSTDEAD", "#7",
  177.     "NET-UNREACH", "HOST-UNREACH", "PROTO-UNREACH", "PORT-UNREACH",
  178.     "#12", "SRCFAIL-UNREACH", "NET-REDIRECT", "HOST-REDIRECT",
  179.     "TOSNET-REDIRECT", "TOSHOST-REDIRECT", "TX-INTRANS", "TX-REASS",
  180.     "PARAMPROB"
  181. };
  182. #endif
  183.  
  184. /*
  185.  * The arguments to ctloutput are:
  186.  *    (*protosw[].pr_ctloutput)(req, so, level, optname, optval);
  187.  * req is one of the actions listed below, so is a (struct socket *),
  188.  * level is an indication of which protocol layer the option is intended.
  189.  * optname is a protocol dependent socket option request,
  190.  * optval is a pointer to a mbuf-chain pointer, for value-return results.
  191.  * The protocol is responsible for disposal of the mbuf chain *optval
  192.  * if supplied,
  193.  * the caller is responsible for any space held by *optval, when returned.
  194.  * A non-zero return from usrreq gives an
  195.  * UNIX error number which should be passed to higher level software.
  196.  */
  197. #define    PRCO_GETOPT    0
  198. #define    PRCO_SETOPT    1
  199.  
  200. #define    PRCO_NCMDS    2
  201.  
  202. #ifdef PRCOREQUESTS
  203. char    *prcorequests[] = {
  204.     "GETOPT", "SETOPT",
  205. };
  206. #endif
  207.  
  208. #ifdef KERNEL
  209. extern    struct protosw *pffindproto(), *pffindtype();
  210. #endif
  211.